<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs for page users.php</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="file-name">/_inc/function/users.php</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
															<a href="#sec-functions">Functions</a>
			</div>
	<div class="info-box-body">	
		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Users Functions, Furasta.Org</p>
<p class="description"><p>Contains function which are useful for dealing with  users and groups.</p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Conor Mac Aoidh &lt;<a href="mailto:conormacaoidh@gmail.com">conormacaoidh@gmail.com</a>&gt;</li>
				<li><span class="field">version:</span> 1.0</li>
				<li><span class="field">todo:</span> implement these functions</li>
				<li><span class="field">license:</span> <a href="http://furasta.org/licence.txt">The BSD License</a></li>
			</ul>
		
			</div>
</div>
		

	
	
	
	<a name="sec-functions"></a>	
	<div class="info-box">
		<div class="info-box-title">Functions</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<span class="disabled">Functions</span>
		</div>
		<div class="info-box-body">	
			<a name="functiongroup_add" id="functiongroup_add"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">group_add</span> (line <span class="line-number">102</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">group_add</p>
<p class="description"><p>creates a new group, adds it to the  database and returns an instance of  the group class for the new group</p></p>
	
	<div class="method-signature">
		<span class="method-result"><a href="../default/Group.html">Group</a></span>
		<span class="method-name">
			group_add
		</span>
				()
			</div>

		
	
</div>
<a name="functiongroup_delete" id="functiongroup_delete"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">group_delete</span> (line <span class="line-number">116</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">group_delete</p>
<p class="description"><p>removes a group from the database, removes all  members of the group from the group, deletes  all group files. returns false on failure</p></p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			group_delete
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>)
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$id</span>			</li>
				</ul>
		
	
</div>
<a name="functionusers_add" id="functionusers_add"><!-- --></a>
<div class="evenrow">
	
	<div>
		<span class="method-title">users_add</span> (line <span class="line-number">38</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">users_add</p>
<p class="description"><p>creates a new user in the database with the  given parameters and returns an instance of  the user class for the new user</p><p>$data    -   an array of items to be JSON encoded in               the data field  $options -   an array of options to be added to the               options database table for the user  $mail    -   an array with the keys 'subject', 'message',               for the users notification email</p></p>
	
	<div class="method-signature">
		<span class="method-result">int</span>
		<span class="method-name">
			users_add
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$email</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$password</span>, [<span class="var-type">array</span>&nbsp;<span class="var-name">$groups</span> = <span class="var-default">array( )</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$data</span> = <span class="var-default">array( )</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$options</span> = <span class="var-default">array( )</span>], [<span class="var-type">array</span>&nbsp;<span class="var-name">$mail</span> = <span class="var-default">true</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$email</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$password</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$groups</span><span class="var-description">: optional</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$data</span><span class="var-description">: optional</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$options</span><span class="var-description">: optional</span>			</li>
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$mail</span><span class="var-description">: optional</span>			</li>
				</ul>
		
	
</div>
<a name="functionusers_delete" id="functionusers_delete"><!-- --></a>
<div class="oddrow">
	
	<div>
		<span class="method-title">users_delete</span> (line <span class="line-number">88</span>)
	</div> 

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">users_delete</p>
<p class="description"><p>removes a user from the database and deletes  all files associated with the user. returns  false on failure</p></p>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			users_delete
		</span>
					(<span class="var-type">int</span>&nbsp;<span class="var-name">$id</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$message</span> = <span class="var-default">&#039;&#039;</span>])
			</div>

			<ul class="parameters">
					<li>
				<span class="var-type">int</span>
				<span class="var-name">$id</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$message</span>			</li>
				</ul>
		
	
</div>
		</div>
	</div>
	
	<p class="notes" id="credit">
		Documentation generated on Thu, 07 Jun 2012 18:22:51 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>